Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restore redocly type in YAML for API docs #372

Closed
wants to merge 4 commits into from
Closed

Restore redocly type in YAML for API docs #372

wants to merge 4 commits into from

Conversation

mjang
Copy link
Contributor

@mjang mjang commented Apr 4, 2025 •
edited
Loading

Proposed changes

Fixes for our current NGINX controller APIs.

Here's what I've tried, based on our working instance in N1C APIs:

  • I've updated ctrl-*-api.md files to match the corresponding nginx-one/api/api-reference-guide.md file
  • I've moved the corresponding API JSON files to the static/controller subdirectory
  • I've tried a couple of different subdirectories.

I've set this to "draft" as this is not a working solution.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

@mjang mjang requested a review from a team as a code owner April 4, 2025 17:26
@github-actions github-actions bot added documentation Improvements or additions to documentation product/controller NGINX Controller (EOS product) labels Apr 4, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 4, 2025

✅ Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/372/

@mjang mjang force-pushed the fix-api-ref-doc-controller branch from 1dcd02b to c93efe3 Compare April 4, 2025 17:49
@mjang mjang marked this pull request as draft April 4, 2025 18:17
@mjang
Copy link
Contributor Author

mjang commented Apr 7, 2025

replaced by #373

@mjang mjang closed this Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation product/controller NGINX Controller (EOS product)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mjang